home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Aminet 5
/
Aminet 5 - March 1995.iso
/
Aminet
/
util
/
misc
/
man35.lha
/
Man3.5
/
DOCS
/
English
/
Man.DOC
next >
Wrap
Text File
|
1994-11-21
|
8KB
|
265 lines
Document Man
Man - © 1993,1994 by Markus Hillenbrand
---------------------------------------
Man is a program to view texts and docs from Shell or WB. Therefore the
Commodity has to be started.
1. Requirements
~~~~~~~~~~~~~~~
You need: - asl.library v37
- intuition.library v37
- gadtools.library v37
- graphics.library v37
- dos.library v37
- icon.library v37
- commodities.library v37
- workbench.library v37
- utility.library v37
- reqtools.library v38 (c) by Nico François
Supported: - locale.library v38
Recommended: - a harddisk to use help-texts efficiently
- "MultiView" from OS3.0 to read .guide files
- "Amigaguide" from OS2.0, if you don´t have 3.0
2. Installer
~~~~~~~~~~~~
As the program 'installer' (© by Commodore) is not freely distributable
and it is needed for installation, you must be sure to have it in the
path of your shell (e.g. C:, SYS:Utilities, ...). You can find the program
on your workbench-disk for OS2.0, OS2.1 or OS3.0.
If your version of installer does not work with the installation-script
of man, you may install 'man' yourself:
1. Click on the icon 'man' and drag it to 'Workbench:WBStartUp'.
2. If you have OS2.1, copy the directory 'Catalogs' to 'Locale:Catalogs'.
3. ToolTypes
~~~~~~~~~~~~
Starting the program, it searches for the following Tooltypes:
3.1. CX_PRIORITY
~~~~~~~~~~~~~~~~
CX_PRIORITY=x, where x stands for a value with -128<x<128. This value
represents the priority for the commodity. Default is 0.
3.2. CX_POPKEY
~~~~~~~~~~~~~~
Here you can enter a hotkey which will open the config-window when
pressed. Default is 'ctrl lalt m'.
3.3. DONOTWAIT
~~~~~~~~~~~~~~
This Entry is not important, it´s only neccesary for system-startup.
3.4. HOTKEY
~~~~~~~~~~~
Here you can enter a hotkey which will open the text-requester when
pressed. Default is 'ctrl help'.
3.5. DATA
~~~~~~~~~
Here you can enter a filename under which the lists of texts will be
saved. Default is 'Work:Man.LST'.
3.6. GUIDE
~~~~~~~~~~
Here you can enter the program to use if you want to read a .guide file.
3.7. DVI
~~~~~~~~
Here you can enter the program to use if you want to read a .dvi file.
3.8. UNIX
~~~~~~~~~
Here you can enter the program to use if you want to read a standard
UNIX man page.
3.9. PROGRAM
~~~~~~~~~~~~~
Here you can enter the program to use if you want to read a plain text
file. The program enteres in the configuration window can be saved here
if you click 'save' in the configuration window.
3.10. REQX and REQY
~~~~~~~~~~~~~~~~~~~
Here you can specify the top left edge of the requester which opens when
you press the hotkey or enter 'man' in your shell. The actual window
position will be saved here if you click 'enter' in the configuration
window.
3.11. WINX and WINY
~~~~~~~~~~~~~~~~~~~
Here you can specify the top left edge of the configuration window. The
actual window position will be saved here if you click 'enter' in the
configuration window.
3.12. REQENTRIES
~~~~~~~~~~~~~~~~
Here you can enter the number of visible entries in the listview of the
requester. If your number is too great, a new value will be calculated.
4. Configuration
~~~~~~~~~~~~~~~~
To configure the program, type "man -c" or "man -config" in your shell.
A window opens where you can enter several specifications.
This window can also be opened by double-clicking the program-icon or
by activating the gadget 'Activate Window' in the program 'Exchange'
(© by Commodore).
The opened window is an AppWindow. This means that you can drop icons
on it. These icons will be added to the list in the listviewgadget.
The window is devided into three parts:
4.1. List of Help-Texts
~~~~~~~~~~~~~~~~~~~~~~~
In the upper halp of the window there is a listview-gadget, where all
actual texts are shown. On the right side there are some gadgets:
4.1.1. Add
~~~~~~~~~~
If you activate this gadget, a requester wille be opened which lets you
add one single textfile to the list of texts.
4.1.2. Delete
~~~~~~~~~~~~
The text highlighted in the listview will be deletet by pressing this gadget.
4.1.3. Edit
~~~~~~~~~~~
The text highlighted in the listview can be edited by pressing this gadget
(i.e. if the path has changed).
4.1.4. ScanDir
~~~~~~~~~~~~~~
With this gadget you can search through a whole directory in order to find
some texts. All subdirectories will be searched as well. This is especially
useful by configuring the program for the first time, because it saves a
lot of time.
4.1.5. DelAll
~~~~~~~~~~~~~
That means: delete all. This gadget lets you delete the whole list of
texts.
4.2. Program to show texts
~~~~~~~~~~~~~~~~~~~~~~~~~~
Here you can enter the program to use for viewing and reading texts (maybe
your favourite text-reader). The gadget on the right opens a requester.
4.3. Standard-Gadgets
~~~~~~~~~~~~~~~~~~~~~
With 'Save' the actual list of texts will be saved. With 'Hide' the win-
dow will be closed and with 'Quit' the program will be removed from memory.
(Changes will NOT be saved).
5. Shell-usage
~~~~~~~~~~~~~~
To read a text from shell, you have to add its name in the command line.
Here you must not enter the suffix! "Man lha" for example searches for
lha.doc, lha.dok, lha.man, and ... in the list.
This text will then be shown with your preferred text-reader. If you enter
"man -l" you´ll get a list of all texts.
If you call man without any parameter, a window os opened where you can
select a text.
If you enter a pattern (#?, ? etc.), all texts matching this pattern will be
listed. If only one text matches, it will be shown immediately.
With "man -q" you can unload the commodity.
6. Localization under WB2.1+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Since Workbench 2.1 the program can be localized, i.e. it can be translated
into several languages. Therefor I added the C source of the catalog. In the
original version only German, Swedish and English are supported.
The C source can easily be changed, and with a suitable program (e.g. MakeCat
- © Paladin-Software etc.) you can rebuild the catalog.
If you have created a new catalog it would be nice if you send me the new
C source via e-mail. Perhaps I can add the new language in a newer version
of man.
7. Copyright
~~~~~~~~~~~~
CAUTION:
Since version 3.1, 'man' is CARDWARE. So you'll have to send me a postcard
of your country/home/city/... with a few words from you (in your own
language ?) if you use 'man' regularly.
'Man' is Copyright (C) 1993 Markus Hillenbrand and it's freely distributable
as long as all of its files are included in their original form without
additions, deletions, or modifications of any kind, and only a nominal fee
is charged for its distribution. This software is provided *AS IS* without
warranty of any kind, either expressed or implied. By using 'Man', you agree
to accept the entire risk as to the quality and performance of the program.
Of course, it was tested rather extensively before it was released...
8. Address of the author
~~~~~~~~~~~~~~~~~~~~~~~~
Here´s my address (bug-report, suggestions or something like that, and the
postcard):
Markus Hillenbrand
Weserstrasse 9
36124 Eichenzell-Loeschenrod
GERMANY
or e-mail: m_hillen@informatik.uni-kl.de
9. Man pages
~~~~~~~~~~~~
If you intend to write a man page for this archive, please read the hints
and tips in the directory "ManPages".
If you are interested in a package of man pages for the original AmigaDOS
commands, feel free to contact Lars Oloffson (e-mail: pt93lo@pt.hk-r.se).
10. Thanks
~~~~~~~~~~
- Nico François for his famous reqtools.library
- Lars Oloffson for his swedish catalog
- Marcus Flehmig for beta-testing
- Stephan Sürken for his program 'Text2Guide'